<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../../../../print.css" type="text/css" media="print">
<meta content="IPipeFitting,org.puremvc.as3.multicore.utilities.pipes.interfaces.IPipeFitting,connect,disconnect,write" name="keywords">
<title>org.puremvc.as3.multicore.utilities.pipes.interfaces.IPipeFitting</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'IPipeFitting - API Documentation';
				var baseRef = '../../../../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">PureMVC AS3 MultiCore Pipes Utility</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../../../../all-classes.html')" href="../../../../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../../../all-classes.html')" href="../../../../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../../../index-list.html')" href="../../../../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../../../../index.html?org/puremvc/as3/multicore/utilities/pipes/interfaces/IPipeFitting.html&amp;org/puremvc/as3/multicore/utilities/pipes/interfaces/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Interface&nbsp;IPipeFitting</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface IPipeFitting"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.puremvc.as3.multicore.utilities.pipes.interfaces</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IPipeFitting</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implementors</td><td><a href="../plumbing/Pipe.html">Pipe</a>, <a href="../plumbing/PipeListener.html">PipeListener</a>, <a href="../plumbing/TeeSplit.html">TeeSplit</a></td>
</tr>
</table>
<p></p> 
  Pipe Fitting Interface.
  <P>
  An <code>IPipeFitting</code> can be connected to other 
  <code>IPipeFitting</code>s, forming a Pipeline. 
  <code>IPipeMessage</code>s are written to one end of a 
  Pipeline by some client code. The messages are then 
  transfered in synchronous fashion from one fitting to 
  the next.</P>
  <p></p>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#connect()">connect</a>(output:<a href="IPipeFitting.html">IPipeFitting</a>):Boolean</div>
<div class="summaryTableDescription">
   Connect another Pipe Fitting to the output.</div>
</td><td class="summaryTableOwnerCol">IPipeFitting</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#disconnect()">disconnect</a>():<a href="../interfaces/IPipeFitting.html">IPipeFitting</a>
</div>
<div class="summaryTableDescription">
   Disconnect the Pipe Fitting connected to the output.</div>
</td><td class="summaryTableOwnerCol">IPipeFitting</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#write()">write</a>(message:<a href="IPipeMessage.html">IPipeMessage</a>):Boolean</div>
<div class="summaryTableDescription">
   Write the message to the output Pipe Fitting.</div>
</td><td class="summaryTableOwnerCol">IPipeFitting</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="connect()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">connect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function connect(output:<a href="IPipeFitting.html">IPipeFitting</a>):Boolean</code><p>
   Connect another Pipe Fitting to the output.
   <P>
   Fittings connect and write to 
   other fittings in a one way syncrhonous
   chain, as water typically flows one direction 
   through a physical pipe.</P>
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">output</span>:<a href="IPipeFitting.html">IPipeFitting</a></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; Boolean true if no other fitting was already connected.
   </td>
</tr>
</table>
</div>
<a name="disconnect()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">disconnect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function disconnect():<a href="../interfaces/IPipeFitting.html">IPipeFitting</a></code><p>
   Disconnect the Pipe Fitting connected to the output.
   <P>
   This disconnects the output fitting, returning a 
   reference to it. If you were splicing another fitting
   into a pipeline, you need to keep (at least briefly) 
   a reference to both sides of the pipeline in order to 
   connect them to the input and output of whatever 
   fiting that you're splicing in.</P>
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../interfaces/IPipeFitting.html">IPipeFitting</a></code> &mdash; 
                        IPipeFitting the now disconnected output fitting
   
                        
                     </td>
</tr>
</table>
</div>
<a name="write()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">write</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function write(message:<a href="IPipeMessage.html">IPipeMessage</a>):Boolean</code><p>
   Write the message to the output Pipe Fitting.
   <P>
   There may be subsequent filters and tees
    (which also implement this interface), that the 
    fitting is writing to, and so a message
    may branch and arrive in different forms at
    different endpoints. </P>
    <P>
    If any fitting in the chain returns false 
    from this method, then the client who originally 
    wrote into the pipe can take action, such as 
    rolling back changes.</P>
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">message</span>:<a href="IPipeMessage.html">IPipeMessage</a></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code></td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
